Documentation updates for 0.16 #864
Merged
+448
−2,083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anmonteiro
reviewed
Nov 24, 2024
docs/components.md
Outdated
| @@ -113,7 +113,7 @@ Reason also always opts for the safest form of a given hook as well. So `React.u | |||
|
|
|||
| ## Hand-writing components | |||
|
|
|||
| You don't need to use the `[@react.component]` declaration to write components. Instead you can write a pair of `foo` and `fooProps` functions such that `type fooProps: 'a => props and foo: props => React.element` and these will always work as React components! This works with your own version of [`[@bs.obj]`](https://melange.re/v2.0.0/communicate-with-javascript/#using-jst-objects), [`[bs.deriving abstract]`](https://melange.re/v2.0.0/communicate-with-javascript/#convert-records-into-abstract-types), or any other function that takes named args and returns a single props structure. | |||
| You don't need to use the `[@react.component]` declaration to write components. Instead you can write a pair of `foo` and `fooProps` functions such that `type fooProps: 'a => props and foo: props => React.element` and these will always work as React components! This works with your own version of [`[@mel.obj]`](https://melange.re/v4.0.0/communicate-with-javascript#using-js-t-objects), [`[bs.deriving abstract]`](https://melange.re/v4.0.0/communicate-with-javascript#using-external-functions), or any other function that takes named args and returns a single props structure. | |||
There was a problem hiding this comment.
we may need some kind of way to centrally update the melange version that we talk about.
There was a problem hiding this comment.
true, maybe move all links into references might make our lives easier, but having a link that points to "latest" might be a better idea
docs/context.md
Outdated
| }; | ||
| ``` | ||
|
|
||
| That will give you a `ContextProvider` component you can use in your application later on, by wrapping any component with `ContextProvider`, to have access to the context value inside the component tree. To know more about Context, check the [official React documentation](https://legacy.reactjs.org/docs/context.html) and [when to use it](https://react.dev/learn/passing-data-deeply-with-context). |
There was a problem hiding this comment.
should we update the legacy doc to https://react.dev/reference/react/createContext?
|
|
||
| - `renderToString` : `React.element => string` | ||
| - `renderToStaticMarkup` : `React.element => string` | ||
|
|
||
| More info about `ReactDOMServer` can be found in the [official React documentation](https://react.dev/reference/react-dom/server). |
There was a problem hiding this comment.
we should add a small section about ReactDOMServerNode, which you can get by depending on reason-react.node
docs/element-type-is-invalid.md
Outdated
| @@ -15,13 +15,13 @@ This likely means that: | |||
| This is a common mistake. Please see Melange's [Import an ES6 Default Value](https://melange.re/v2.0.0/communicate-with-javascript/#default-es6-values). Aka, instead of: | |||
There was a problem hiding this comment.
I saw you updated the link to point to v4 above. we should likely update the melange doc links across the entire docs to be consistent, in that case.
| }; | ||
| ``` | ||
|
|
||
| ## Using Event values with useState |
There was a problem hiding this comment.
this is duplicated from docs/usestate-event-value.md. are you planning to delete that page?
Co-authored-by: Antonio Nuno Monteiro <[email protected]>
Co-authored-by: Antonio Nuno Monteiro <[email protected]>
Co-authored-by: Antonio Nuno Monteiro <[email protected]>
Co-authored-by: Antonio Nuno Monteiro <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ReactEvent->React.Eventin docs #831)